<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>EDevice</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="https://code.google.com/p/epyat">epyat</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Module&nbsp;EDevice
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="EDevice-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module EDevice</h1><p class="nomargin-top"><span class="codelink"><a href="EDevice-pysrc.html">source&nbsp;code</a></span></p>
<p>The EDevice module gives access to general information about the 
  GPRS-module and to general control functionallity.</p>
  <p>All functions in this module may throw an EInterface.CommandError or 
  an EInterface.TimeoutException, if a command used by this function 
  couldn't be executed properly. However, this should only happen in these 
  functions, where the exception is documented.</p>

<hr />
<div class="fields">      <p><strong>Author:</strong>
        Patrick Strobel
      </p>
      <p><strong>Version:</strong>
        $Revision: 14 $
      </p>
</div><!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">string</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="EDevice-module.html#getImei" class="summary-sig-name">getImei</a>()</span><br />
      Gets the International Mobile Equipment Identity (IMEI), the module's
      serial number.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="EDevice-pysrc.html#getImei">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">string</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="EDevice-module.html#getImsi" class="summary-sig-name">getImsi</a>()</span><br />
      Gets the International Mobile Subscriber Identity (IMSI).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="EDevice-pysrc.html#getImsi">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">string</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="EDevice-module.html#getManufacturer" class="summary-sig-name">getManufacturer</a>()</span><br />
      Gets the manufacturer of the module.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="EDevice-pysrc.html#getManufacturer">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">string</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="EDevice-module.html#getModel" class="summary-sig-name">getModel</a>()</span><br />
      Gets the model of the module.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="EDevice-pysrc.html#getModel">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">string</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="EDevice-module.html#getSoftwareRevision" class="summary-sig-name">getSoftwareRevision</a>()</span><br />
      Gets the revision of the software running on the module.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="EDevice-pysrc.html#getSoftwareRevision">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="EDevice-module.html#reboot" class="summary-sig-name">reboot</a>()</span><br />
      Reboots the module.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="EDevice-pysrc.html#reboot">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="EDevice-module.html#shutdown" class="summary-sig-name">shutdown</a>()</span><br />
      Turns the module off.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="EDevice-pysrc.html#shutdown">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Variables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="None">None</code>
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="getImei"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getImei</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="EDevice-pysrc.html#getImei">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gets the International Mobile Equipment Identity (IMEI), the module's 
  serial number.</p>
  <p>Command: AT+CGSN</p>
  <dl class="fields">
    <dt>Returns: string</dt>
        <dd>The serial number</dd>
  </dl>
</td></tr></table>
</div>
<a name="getImsi"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getImsi</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="EDevice-pysrc.html#getImsi">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gets the International Mobile Subscriber Identity (IMSI).</p>
  <p>Command: AT+CIMI</p>
  <dl class="fields">
    <dt>Returns: string</dt>
        <dd>The IMSI.</dd>
    <dt>Raises:</dt>
    <dd><ul class="nomargin-top">
        <li><code><strong class='fraise'><a href="EInterface.CommandError-class.html">EInterface.CommandError</a></strong></code> - Thrown, if the IMSI couldn't be read because no SIM is inserted.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="getManufacturer"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getManufacturer</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="EDevice-pysrc.html#getManufacturer">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gets the manufacturer of the module.</p>
  <p>Command: AT+CGMI</p>
  <dl class="fields">
    <dt>Returns: string</dt>
        <dd>The manufacturer.</dd>
  </dl>
</td></tr></table>
</div>
<a name="getModel"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getModel</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="EDevice-pysrc.html#getModel">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gets the model of the module.</p>
  <p>Command: AT+CGMM</p>
  <dl class="fields">
    <dt>Returns: string</dt>
        <dd>The module's name.</dd>
  </dl>
</td></tr></table>
</div>
<a name="getSoftwareRevision"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getSoftwareRevision</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="EDevice-pysrc.html#getSoftwareRevision">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gets the revision of the software running on the module.</p>
  <p>Command: AT+CGMR</p>
  <dl class="fields">
    <dt>Returns: string</dt>
        <dd>The software revision.</dd>
  </dl>
</td></tr></table>
</div>
<a name="reboot"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">reboot</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="EDevice-pysrc.html#reboot">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Reboots the module.</p>
  <p>Command: AT#REBOOT</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="shutdown"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">shutdown</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="EDevice-pysrc.html#shutdown">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Turns the module off.</p>
  <p>Command: AT#SHDN</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="https://code.google.com/p/epyat">epyat</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Mon Oct 01 17:02:04 2012
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
